<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpgimprc: GIMP 3 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GIMP 3 Library Reference Manual">
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="prev" href="libgimp3-gimpcontext.html" title="gimpcontext">
<link rel="next" href="libgimp3-gimphelp.html" title="gimphelp">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgimp3-gimpgimprc.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgimp3-gimpcontext.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgimp3-gimphelp.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgimp3-gimpgimprc"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp3-gimpgimprc.top_of_page"></a>gimpgimprc</span></h2>
<p>gimpgimprc — Interactions with settings from gimprc.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgimp3-gimpgimprc.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgimprc.html#gimp-gimprc-query" title="gimp_gimprc_query ()">gimp_gimprc_query</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgimprc.html#gimp-gimprc-set" title="gimp_gimprc_set ()">gimp_gimprc_set</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../html/GimpColorConfig.html#GimpColorConfig-struct"><span class="returnvalue">GimpColorConfig</span></a> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgimprc.html#gimp-get-color-configuration" title="gimp_get_color_configuration ()">gimp_get_color_configuration</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgimprc.html#gimp-get-default-comment" title="gimp_get_default_comment ()">gimp_get_default_comment</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpunit.html#GimpUnit"><span class="returnvalue">GimpUnit</span></a>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgimprc.html#gimp-get-default-unit" title="gimp_get_default_unit ()">gimp_get_default_unit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgimprc.html#gimp-get-module-load-inhibit" title="gimp_get_module_load_inhibit ()">gimp_get_module_load_inhibit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libgimp3-gimpgimprc.html#gimp-get-monitor-resolution" title="gimp_get_monitor_resolution ()">gimp_get_monitor_resolution</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgimp3-gimpgimprc.description"></a><h2>Description</h2>
<p>Interactions with settings from gimprc.</p>
</div>
<div class="refsect1">
<a name="libgimp3-gimpgimprc.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-gimprc-query"></a><h3>gimp_gimprc_query ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_gimprc_query (<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>);</pre>
<p>Queries the gimprc file parser for information on a specified token.</p>
<p>This procedure is used to locate additional information contained in
the gimprc file considered extraneous to the operation of GIMP.
Plug-ins that need configuration information can expect it will be
stored in the user gimprc file and can use this procedure to
retrieve it. This query procedure will return the value associated
with the specified token. This corresponds _only_ to entries with
the format: (&lt;token&gt; &lt;value&gt;). The value must be a
string. Entries not corresponding to this format will cause warnings
to be issued on gimprc parsing and will not be queryable.</p>
<div class="refsect3">
<a name="gimp-gimprc-query.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>token</p></td>
<td class="parameter_description"><p>The token to query for.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gimprc-query.returns"></a><h4>Returns</h4>
<p>The value associated with the queried token.
The returned value must be freed with <code class="function">g_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-gimprc-set"></a><h3>gimp_gimprc_set ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_gimprc_set (<em class="parameter"><code>const <span class="type">gchar</span> *token</code></em>,
                 <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
<p>Sets a gimprc token to a value and saves it in the gimprc.</p>
<p>This procedure is used to add or change additional information in
the gimprc file that is considered extraneous to the operation of
GIMP. Plug-ins that need configuration information can use this
function to store it, and <a class="link" href="libgimp3-gimpgimprc.html#gimp-gimprc-query" title="gimp_gimprc_query ()"><code class="function">gimp_gimprc_query()</code></a> to retrieve it. This
will accept _only_ string values in UTF-8 encoding.</p>
<div class="refsect3">
<a name="gimp-gimprc-set.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>token</p></td>
<td class="parameter_description"><p>The token to add or modify.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>The value to set the token to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-gimprc-set.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-color-configuration"></a><h3>gimp_get_color_configuration ()</h3>
<pre class="programlisting"><a href="../html/GimpColorConfig.html#GimpColorConfig-struct"><span class="returnvalue">GimpColorConfig</span></a> *
gimp_get_color_configuration (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Retrieve a copy of the current color management configuration.</p>
<div class="refsect3">
<a name="gimp-get-color-configuration.returns"></a><h4>Returns</h4>
<p>A copy of the core's <a href="../html/GimpColorConfig.html#GimpColorConfig-struct"><span class="type">GimpColorConfig</span></a>. You
should unref this copy if you don't need it any longer. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-default-comment"></a><h3>gimp_get_default_comment ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_get_default_comment (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Get the default image comment as specified in the Preferences.</p>
<p>Returns a copy of the default image comment.</p>
<div class="refsect3">
<a name="gimp-get-default-comment.returns"></a><h4>Returns</h4>
<p>Default image comment.
The returned value must be freed with <code class="function">g_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-default-unit"></a><h3>gimp_get_default_unit ()</h3>
<pre class="programlisting"><a href="/local/head/share/gtk-doc/html/libgimpbase/libgimpbase-gimpunit.html#GimpUnit"><span class="returnvalue">GimpUnit</span></a>
gimp_get_default_unit (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Get the default unit (taken from the user's locale).</p>
<p>Returns the default unit's integer ID.</p>
<div class="refsect3">
<a name="gimp-get-default-unit.returns"></a><h4>Returns</h4>
<p>Default unit. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-module-load-inhibit"></a><h3>gimp_get_module_load_inhibit ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
gimp_get_module_load_inhibit (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Get the list of modules which should not be loaded.</p>
<p>Returns a copy of the list of modules which should not be loaded.</p>
<div class="refsect3">
<a name="gimp-get-module-load-inhibit.returns"></a><h4>Returns</h4>
<p>The list of modules.
The returned value must be freed with <code class="function">g_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gimp-get-monitor-resolution"></a><h3>gimp_get_monitor_resolution ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gimp_get_monitor_resolution (<em class="parameter"><code><span class="type">gdouble</span> *xres</code></em>,
                             <em class="parameter"><code><span class="type">gdouble</span> *yres</code></em>);</pre>
<p>Get the monitor resolution as specified in the Preferences.</p>
<p>Returns the resolution of the monitor in pixels/inch. This value is
taken from the Preferences (or the windowing system if this is set
in the Preferences) and there's no guarantee for the value to be
reasonable.</p>
<div class="refsect3">
<a name="gimp-get-monitor-resolution.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>xres</p></td>
<td class="parameter_description"><p>X resolution. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>yres</p></td>
<td class="parameter_description"><p>Y resolution. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gimp-get-monitor-resolution.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>